description = "A WOActiveImage displays an image within the HTML page. If the WOActiveImage is disabled, it simply displays its image as a passive element in the page. If enabled, the image is active, that is, clicking the image generates a request. If located outside an HTML form, a WOActiveImage functions as a mapped, active image. When the user clicks such a WOActiveImage, the coordinates of the click are sent back to the server. Depending on where the user clicks, different actions can be invoked. An image map file associates actions with each of the defined areas of the image. Within an HTML form, a WOActiveImage functions as a graphical submit button. You typically use WOActiveImages when you need more than one submit button within a form.";
attributes = ({
name = "action";
description = "Method to invoke when this element is clicked. If imageMapFile is specified, action is only invoked if the click is outside any mapped area. In other words, action defines the default action of the active image.";
},{
name = "disabled";
description = "If YES, a regular image element (<IMG>) is generated rather than an active image.";
default = "NO";
values = ("YES","NO");
},{
name = "filename";
description = "Path to the image relative to the WebServerRecources directory";
},{
name = "framework";
description = "Framework that contains the image file. This attribute is only necessary if the image file is in a different location from the component. That is, if the component and the image file are both in the application or if the component and the image file are both in the same framework, this attribute isn╒t necessary. If the image file is in a framework and the component is in an application, specify the framework╒s name here (minus the .framework extension). If the image file should be in the application but the component is in a framework, specify the \"app\" keyword in place of the framework name.";
default = "\"app\"";
},{
name = "href";
description = "URL to direct the browser to as a default when the image is clicked and no hot zones are hit.";
},{
name = "imageMapFile";
description = "Name of the image map file.";
},{
name = "name";
description = "If name is specified then the hit point is specified as name.x=value; name.y=value; in the form. This is useful when you need to use this element to submit a form to an external URL that expects the hit point to be expressed in a certain format.";
},{
name = "src";
description = "URL containing the image data. Use this attribute for complete URLs; for relative URLs use filname instead.";
},{
name = "target";
description = "Frame in a frameset that will receive the page returned as a result of the user's click.";
default = "\"_parent\"";
values = ("\"_parent\"","\"_main\"","\"_top\"");
},{
name = "value";
description = "Image data in the form of a WOElement object. This data can come from a database, a file, or memory.";
},{
name = "x";
description = "If specified, returns the coordinates of the user's click within the image.";
},{
name = "y";
description = "If specified, returns the coordinates of the user's click within the image.";
});
type = "WO_Standard";
};
WOApplet = {
name = "WOApplet";
description = "WOApplet is a dynamic element that generates HTML to specify a Java applet. The applet's parameters are passed by one or more WOParam elements.";
attributes = ({
name = "align";
description = "Alignment of the applet. Possible values are top, bottom, left, right, and middle.";
description = "Comma-separated list of URLs for jar archive files containing classes and other resources that will be preloaded. (Note: Currently, most browser do not support a comma-separated list, so only a single archive file may be used.) Use this attribute for archive files that you have generated outside of a WebObjects application or framework. The value for this attribute is appended to the archiveNames attribute value";
},{
name = "archiveNames";
description = "Comma-separated list of archive files containing classes and other resources that will be preloaded. (Note: Currently, most browser do not support a comma-separated list, so only a single archive file may be used.) Use this attribute for archive files that are built as part of a WebObjects application or framework project.";
},{
name = "associatedClass";
description = "Name of Java subclass of next.wo.client.Association that aids in communication between client applet and the server.";
default = "\"next.wo.client.SimpleAssociation\"";
},{
name = "backgroundColor";
description = "The color of the applet background. The background of an applet depends upon the type of object. The TextFieldApplet, for example, displays the area behind typed text in the background color. You must specify colors as a string. The string is either the name of color or it may contain six hexadecimal digits to be interpreted in pairs as RGB values. Colors specified as hexadecimal values may start with the \"#\" character (although this is not required).";
description = "Directory that contains the applet code. If this attribute is omitted, the applet code is assumed to be in the same directory as the template HTML file.";
default = "\"/WebObjects/Java\"";
},{
name = "enabled";
description = "If enabled evaluates to \"NO\", the applet appears in the page but is not active. The disabled state is manifest differently for each control. For example, a TextFieldApplet will not accept the insertion of a cursor. A disabled button has a grayed-out title and doesn't react to clicks. The default setting is \"YES\".";
default = "\"NO\"";
values = ("\"YES\"","\"NO\"");
},{
name = "foregroundColor";
description = "The color of the applet foreground. The foreground of an applet depends upon the type of object. The TextFieldApplet, for example, displays typed text in the foreground color. You must specify colors as a string. The string is either the name of a color or it may contain six hexadecimal digits to be interpreted in pairs as RGB values. Colors specified as hexadecimal values may start with the \"#\" character (although this is not required).";
description = "Height, in pixels, of the area to allocate for the applet.";
},{
name = "hspace";
description = "Amount of whitespace (in pixels) to the left and right of the applet.";
},{
name = "object";
description = "File containing serialized representation of the applet.";
},{
name = "width";
description = "Width, in pixels, of the area to allocate for the applet.";
},{
name = "vspace";
description = "Amount of whitespace (in pixels) at the top and bottom of the applet.";
});
type = "WO_Standard";
};
WOBody = {
name = "WOBody";
description = "WOBody specifies the background image to display for the HTML page.";
attributes = ({
name = "filename";
description = "Path to the image relative to the WebServerRecources directory";
},{
name = "framework";
description = "Framework that contains the image file. This attribute is only necessary if the image file is in a different location from the component. That is, if the component and the image file are both in the application or if the component and the image file are both in the same framework, this attribute isn╒t necessary. If the image file is in a framework and the component is in an application, specify the framework╒s name here (minus the .framework extension). If the image file should be in the application but the component is in a framework, specify the \"app\" keyword in place of the framework name.";
default = "\"app\"";
},{
name = "src";
description = "URL containing the image data. Use this attribute for complete URLs; for relative URLs use filname instead.";
});
type = "WO_Standard";
};
WOBrowser = {
name = "WOBrowser";
description = "WOBrowser displays itself as a selection list that allows the user to select multiple items at a time. The related element WOPopUpButton is similar to WOBrowser except that it restricts the user to selecting only one item at a time.";
attributes = ({
name = "disabled";
description = "If disabled evaluates to YES, this element appears in the page but is not active.";
default = "NO";
values = ("YES","NO");
},{
name = "item";
description = "Identifier for the elements of the list. For example, aCollege could represent an object in the colleges array.";
},{
name = "list";
description = "Array of objects from which the browser derives its values. For example, colleges could name the list containing objects that represent individual schools.";
},{
name = "name";
description = "Name that uniquely identifies this element within the form. You can specify a name or let WebObjects automatically assign one at runtime.";
},{
name = "selections";
description = "Array of objects that the user chose from list. For the college example, selections would hold college objects.";
},{
name = "value";
description = "Value to display in the selection list; for example, aCollege.name for each college object in the list.";
});
type = "WO_Standard";
};
WOCheckBox = {
name = "WOCheckBox";
description = "A WOCheckBox object displays itself in the HTML page as its namesake, a check box user interface control. It corresponds to the HTML element <INPUT TYPE=\"CHECKBOX\"...>.";
attributes = ({
name = "checked";
description = "During page generation, if checked evaluates to YES, the check box appears in the checked state. During request handling, checked reflects the state the user left the check box in: YES if checked; NO if not.";
},{
name = "disabled";
description = "If disabled evaluates to YES, this element appears in the page but is not active.";
default = "NO";
values = ("YES","NO");
},{
name = "name";
description = "Name that uniquely identifies this element within the form. You may specify a name or let WebObjects automatically assign one at runtime.";
},{
name = "selection";
description = "If selection and value are equal when the page is generated, the check box is checked. When the page is submitted, selection is assigned the value of the check box.";
},{
name = "value";
description = "Value of this input element. If not specified, WebObjects provides a default value.";
});
type = "WO_Standard";
};
WOConditional = {
name = "WOConditional";
description = "A WOConditional object controls whether a portion of the HTML page will be generated, based on the evaluation of its assigned condition. ";
attributes = ({
name = "condition";
description = "Expression to evaluate. If the expression evaluates to YES (assuming negate is NO), the HTML code controlled by the WOConditional object is emitted; otherwise it is not.";
},{
name = "negate";
description = "Inverts the sense of the condition. By default, negate is assumed to be NO.";
default = "NO";
values = ("YES","NO");
});
type = "WO_Standard";
};
WOEmbeddedObject = {
name = "WOEmbeddedObject";
description = "A WOEmbeddedObject provides support for Netscape plug-ins. It corresponds to the HTML element <EMBED SRC = >. If the embedded object's content comes from outside the WebObjects application, use the src attribute. If the embedded object's content is returned by a method within the WebObjects application, use the value attribute.";
attributes = ({
name = "filename";
description = "Path to the image relative to the WebServerRecources directory";
},{
name = "framework";
description = "Framework that contains the image file. This attribute is only necessary if the image file is in a different location from the component. That is, if the component and the image file are both in the application or if the component and the image file are both in the same framework, this attribute isn╒t necessary. If the image file is in a framework and the component is in an application, specify the framework╒s name here (minus the .framework extension). If the image file should be in the application but the component is in a framework, specify the \"app\" keyword in place of the framework name.";
default = "\"app\"";
},{
name = "src";
description = "URL containing the embedded object. Use this attribute for complete URLs; for relative URLs use filname instead.";
},{
name = "value";
description = "Method that will supply the content for this embedded object.";
});
type = "WO_Standard";
};
WOForm = {
name = "WOForm";
description = "A WOForm is a container element that generates a fill-in form. It gathers the input from the input elements it contains and sends it to the server for processing. WOForm corresponds to the HTML element <FORM ... > ... </FORM>.";
attributes = ({
name = "action";
description = "Action method that's invoked when the form is submitted. If the form contains a dynamic element that has its own action (such as a WOSubmitButton or a WOActiveImage), that action is invoked instead of the WOForm's.";
},{
name = "href";
description = "URL specifying where the form will be submitted.";
},{
name = "multipleSubmit";
description = "If multipleSubmit evaluates to YES, the form can have more than one WOSubmitButton, each with its own action. By default, WOForm supports only a single WOSubmitButton. Note: Some older browsers support only a single submit button in a form.";
values = ("YES","NO");
});
type = "WO_Standard";
};
WOFrame = {
name = "WOFrame";
description = "WOFrame represents itself as a dynamically generated Netscape Frame element. ";
attributes = ({
name = "pageName";
description = "Name of WebObjects page that will supply the content for this frame.";
},{
name = "src";
description = "External source that will supply the content for this frame.";
},{
name = "value";
description = "Method that will supply the content for this frame.";
});
type = "WO_Standard";
};
WOGenericContainer = {
name = "WOGenericContainer";
description = "WOGenericContainer provides a way for WebObjects to accommodate custom HTML container elements, that is, elements that affect a range of text. Since the HTML language is evolving rapidly, it's convenient to have a way to dynamically generate elements which are not explicitly supported by WebObjects. In HTML, a container element (for example, <A ... > ... </A>) has opening and closing tags that delimit the text or graphic affected by the element. In contrast, an empty element (for example <HR> or <BR>) is represented by a single tag and so can't enclose any text or graphics. (See the related element WOGenericElement for information about the support of empty elements.) ";
attributes = ({
name = "elementName";
description = "Name of the HTML element to generate. This name (for example \"TEXTAREA\") will be used to generate the container's opening and closing tags (<TEXTAREA>...</TEXTAREA>)";
});
type = "WO_Standard";
};
WOGenericElement = {
name = "WOGenericElement";
description = "WOGenericElement provides a way for WebObjects to accommodate custom HTML elements that are empty, that is, that don't affect a range of text. Since the HTML language is evolving rapidly, it's convenient to have a way to dynamically generate elements which are not explicitly supported by WebObjects. In HTML, an empty element (for example <HR> or <BR>) is represented by a single tag and so can't enclose any text or graphics. In contrast, a container element (for example, <A ... > ... </A>) has opening and closing tags that delimit the text or graphic affected by the element. (See the related element WOGenericContainer for information about the support of container elements.) ";
attributes = ({
name = "elementName";
description = "Name of the HTML element to generate. This name (for example \"HR\") will be used to generate the element's tag (<HR>).";
});
type = "WO_Standard";
};
WOHiddenField = {
name = "WOHiddenField";
description = "A WOHiddenField adds hidden text to the HTML page. It corresponds to the HTML element <INPUT TYPE=\"HIDDEN\"...>. Hidden fields are sometimes used to store application state data in the HTML page. In WebObjects, the WOStateStorage element is designed expressly for this purpose.";
attributes = ({
name = "disabled";
description = "If disabled evaluates to YES, the element appears in the page but is not active.";
default = "NO";
values = ("YES","NO");
},{
name = "name";
description = "Name that uniquely identifies this element within the form. You may specify a name or let WebObjects automatically assign one at runtime.";
},{
name = "value";
description = "Value for the hidden text field.";
});
type = "WO_Standard";
};
WOHyperlink = {
name = "WOHyperlink";
description = "WOHyperlink generates a hypertext link in an HTML document.";
attributes = ({
name = "action";
description = "Action method to invoke when this element is activated. The method must return a WOElement.";
},{
name = "disabled";
description = "If evaluates to YES, the content string is displayed, but the hyperlink is not active.";
default = "NO";
values = ("YES","NO");
},{
name = "fragmentIdentifier";
description = "Named location to display in the destination page.";
},{
name = "href";
description = "URL to direct the browser to when the image is clicked.";
},{
name = "pageName";
description = "Name of WebObjects page to display when the link is clicked.";
},{
name = "string";
description = "Text displayed to the user as the link. If you include any text between the <WEBOBJECTS ...> and </WEBOBJECT> tags for this element, the contents of string is appended to that text.";
},{
name = "target";
description = "Frame in a frameset that will receive the page returned as a result of the user's click.";
default = "\"_parent\"";
values = ("\"_parent\"","\"_main\"","\"_top\"");
});
type = "WO_Standard";
};
WOImage = {
name = "WOImage";
description = "A WOImage displays an image in the HTML. It corresponds to the HTML element <IMG SRC=\"URL\">. ";
attributes = ({
name = "filename";
description = "Path to the image relative to the WebServerRecources directory";
},{
name = "framework";
description = "Framework that contains the image file. This attribute is only necessary if the image file is in a different location from the component. That is, if the component and the image file are both in the application or if the component and the image file are both in the same framework, this attribute isn╒t necessary. If the image file is in a framework and the component is in an application, specify the framework╒s name here (minus the .framework extension). If the image file should be in the application but the component is in a framework, specify the \"app\" keyword in place of the framework name.";
default = "\"app\"";
},{
name = "src";
description = "URL containing the image data. Use this attribute for complete URLs; for relative URLs use filname instead.";
},{
name = "value";
description = "Image data in the form of a WOElement object. This data can come from a database, a file, or memory.";
});
type = "WO_Standard";
};
WOImageButton = {
name = "WOImageButton";
description = "WOImageButton is a graphical submit button. Clicking the image generates a request and submits the enclosing form's values. You often use WOImageButton when you need more than one submit button within a form.";
attributes = ({
name = "action";
description = "Method to invoke when this element is clicked. If imageMapFile is specified, action is only invoked if the click is outside any mapped area. In other words, action defines the default action of the active image.";
},{
name = "disabled";
description = "If YES, a regular image element (<IMG>) is generated rather than an active image.";
default = "NO";
values = ("YES","NO");
},{
name = "filename";
description = "Path to the image relative to the WebServerRecources directory";
},{
name = "framework";
description = "Framework that contains the image file. This attribute is only necessary if the image file is in a different location from the component. That is, if the component and the image file are both in the application or if the component and the image file are both in the same framework, this attribute isn╒t necessary. If the image file is in a framework and the component is in an application, specify the framework╒s name here (minus the .framework extension). If the image file should be in the application but the component is in a framework, specify the \"app\" keyword in place of the framework name.";
default = "\"app\"";
},{
name = "href";
description = "URL to direct the browser to as a default when the image is clicked and no hot zones are hit.";
},{
name = "imageMapFile";
description = "Name of the image map file.";
},{
name = "name";
description = "If name is specified then the hit point is specified as name.x=value; name.y=value; in the form. This is useful when you need to use this element to submit a form to an external URL that expects the hit point to be expressed in a certain format.";
},{
name = "src";
description = "URL containing the image data. Use this attribute for complete URLs; for relative URLs use filname instead.";
},{
name = "target";
description = "Frame in a frameset that will receive the page returned as a result of the user's click.";
default = "\"_parent\"";
values = ("\"_parent\"","\"_main\"","\"_top\"");
},{
name = "value";
description = "Image data in the form of a WOElement object. This data can come from a database, a file, or memory.";
},{
name = "x";
description = "If specified, returns the coordinates of the user's click within the image.";
},{
name = "y";
description = "If specified, returns the coordinates of the user's click within the image.";
});
type = "WO_Standard";
};
WOJavaScript = {
name = "WOJavaScript";
description = "WOJavaScript lets you embed a script written in JavaScript in a dynamically generated page.";
attributes = ({
name = "hideInComment";
description = "If hideInComment evaluates to YES, the script will be enclosed in an HTML comment (<!-- script //-->). Since scripts can generate errors in some older browsers that weren't designed to execute them, you may want to enclose your script in an HTML comment. Browsers designed to run these scripts will still be able to execute them despite the surrounding comment tags.";
default = "YES";
values = ("YES","NO");
},{
name = "scriptFile";
description = "Path to the file containing the script. The path can be statically specified in the declaration file or it can be an NSString, an object that responds to a description message by returning an NSString, or a method that returns an NSString.";
},{
name = "scriptSource";
description = "URL specifying the location of the script.";
},{
name = "scriptString";
description = "String containing the script. Typically, scriptString is an NSString object, an object that responds to a description message by returning an NSString, or a method that returns an NSString.";
});
type = "WO_Standard";
};
WOParam = {
name = "WOParam";
description = "Parameter fƒr WOApplet";
attributes = ({
name = "action";
description = "Method that the applet will invoke.";
},{
name = "name";
description = "Symbolic name associated with this element's value.";
},{
name = "value";
description = "Value of this parameter.";
});
type = "WO_Standard";
};
WOPasswordField = {
name = "WOPasswordField";
description = "A WOPasswordField represents itself as a text field that doesn't echo the characters that a user enters. It corresponds to the HTML element <INPUT TYPE=\"PASSWORD\"...>. ";
attributes = ({
name = "disabled";
description = "If disabled evaluates to YES, the element appears in the page but is not active. ";
default = "NO";
values = ("YES","NO");
},{
name = "name";
description = "Name that uniquely identifies this element within the form. You may specify a name or let WebObjects automatically assign one at runtime.";
},{
name = "value";
description = "During page generation, value sets the default value of the text field. This value is not displayed to the user. During request handling, value holds the value the user entered into the field, or the default value if the user left the field untouched.";
});
type = "WO_Standard";
};
WOPopUpButton = {
name = "WOPopUpButton";
description = "WOPopUpButton displays itself as a selection list that allows the user to select only one item at a time. The related element WOBrowser is similar to WOPopUpButton except that it allows the user to select more than one item at a time.";
attributes = ({
name = "disabled";
description = "If disabled evaluates to YES, this element appears in the page but is not active.";
default = "NO";
values = ("YES","NO");
},{
name = "item";
description = "Identifier for the elements of the list. For example, aCollege could represent an object in the colleges array.";
},{
name = "list";
description = "Array of objects from which the WOPopUpButton derives its values. For example, colleges could name the array containing objects that represent individual schools.";
},{
name = "name";
description = "Name that uniquely identifies this element within the form. You can specify a name or let WebObjects automatically assign one at runtime.";
},{
name = "selection";
description = "Array of objects that the user chose from the selection list. For the college example, selection would hold college objects. Since a WOPopUpButton lets the user select only one item at a time, this array holds no more than one item.";
},{
name = "value";
description = "Value to display in the selection list; for example, aCollege.name for each college object in the list.";
});
type = "WO_Standard";
};
WORadioButton = {
name = "WORadioButton";
description = "WORadioButton represents itself as an on-off switch. Radio buttons are normally grouped, since the most important aspect of their behavior is that they allow the user to select no more than one of several choices. If the user selects one button, the previously selected button (if any) becomes deselected. Since radio buttons normally appear as a group, WORadioButton is commonly found within a WORepetition. ";
attributes = ({
name = "checked";
description = "During page generation, if checked evaluates to YES, the radio button appears in the selected state. During request handling, checked reflects the state the user left the radio button in: YES if checked; NO if not.";
},{
name = "disabled";
description = "If disabled evaluates to YES, this element appears in the page but is not active.";
default = "NO";
values = ("YES","NO");
},{
name = "name";
description = "Name that identifies the radio button's group. Only one radio button at a time can be selected within a group.";
},{
name = "selection";
description = "If selection and value are equal when the page is generated, the radio button is selected. When the page is submitted, selection is assigned the value of the radio button.";
},{
name = "value";
description = "Value of this input element. If not specified, WebObjects provides a default value.";
});
type = "WO_Standard";
};
WORepetition = {
name = "WORepetition";
description = "A WORepetition is a container element that repeats its contents (that is, everything between the <WEBOBJECT...> and </WEBOBJECT...> tags in the template file) a given number of times. You can use a WORepetition to create dynamically generated ordered and unordered lists or banks of check boxes or radio buttons. ";
attributes = ({
name = "count";
description = "Number of times this element will repeat its contents.";
},{
name = "identifier";
description = "Value used to uniquely identify this item in the list array. Typically it is the primary key of an enterprise object.";
},{
name = "index";
description = "Index of the current iteration of the WORepetition.";
},{
name = "item";
description = "Current item in the list array.";
},{
name = "list";
description = "Array of objects that the WORepetition will iterate through.";
});
type = "WO_Standard";
};
WOResetButton = {
name = "WOResetButton";
description = "A WOResetButton element generates a reset button in an HTML page. This element is used within HTML forms. ";
attributes = ({
name = "value";
description = "Title of the button.";
});
type = "WO_Standard";
};
WOStateStorage = {
name = "WOStateStorage";
description = "A WOStorage element provides a simple mechanism for storing application state in an HTML page. If you include a WOStateStorage element in a form, any session and persistent data will be stored in the page rather than on the server.";
attributes = ({
name = "size";
description = "Maximum size for each of the hidden fields used to store the state data. This attribute is optional; if size is not specified, the maximum size for hidden fields will be 1000 bytes.";
default = "1000";
});
type = "WO_Standard";
};
WOString = {
name = "WOString";
description = "A WOString represents itself in the HTML page as a dynamically generated string. ";
attributes = ({
name = "dateformat";
description = "A format string that specifies how value should be formatted as a date. If a date format is used, value must be assigned an NSCalendarDate object. If value can't be interpreted according to the format you specify, value is set to nil. See the NSCalendarDate class specification for a description of the date format syntax.";
description = "If escapeHTML is YES, HTML tags in WOString's contents are protected from being interpreted by the browser; otherwise, they are not.";
default = "NO";
values = ("YES","NO");
},{
name = "numberformat";
description = "A format string that specifies how value should be formatted as a number. If a number format is used, value must be assigned an NSDecimalNumber object. If the element's value can't be interpreted according to the format you specify, value is set to nil. See the NSNumberFormatter class specification for a description of the number format syntax.";
description = "Text to display in the HTML page. value is typically assigned an NSString object, an object that responds to a description message by returning an NSString, or a method that returns an NSString.";
});
type = "WO_Standard";
};
WOSubmitButton = {
name = "WOSubmitButton";
description = "A WOSubmitButton element generates a submit button in an HTML page. This element is used within HTML forms. ";
attributes = ({
name = "action";
description = "Action method to invoke when the form is submitted.";
},{
name = "disabled";
description = "If disabled evaluates to YES, the element appears in the page but is not active.";
default = "NO";
values = ("YES","NO");
},{
name = "name";
description = "Name that uniquely identifies this element within the form. You may specify a name or let WebObjects automatically assigns one at runtime.";
},{
name = "value";
description = "Title of the button.";
});
type = "WO_Standard";
};
WOSwitchComponent = {
name = "WOSwitchComponent";
description = "WOSwitchComponent provides a way to determine at runtime which nested component should be displayed. This component is useful when you want to decide how to display information based on the state of the application. If the component specified in WOComponentName takes attributes, pass these attributes along to WOSwitchComponent following the WOComponentName attribute. Note that this means that all components that can be displayed by this WOSwitchComponent must use the same API.";
attributes = ({
name = "WOComponentName";
description = "Name of the component to display. This attribute can be a string or a method that returns the name of a component.";
});
type = "WO_Standard";
};
WOText = {
name = "WOText";
description = "WOText generates a multi-line field for text input and display. It corresponds to the HTML element <TEXTAREA>. ";
attributes = ({
name = "disabled";
description = "If disabled evaluates to YES, the text area appears in the page but no input is allowed.";
default = "NO";
values = ("YES","NO");
},{
name = "name";
description = "Name that uniquely identifies this element within the form. You may specify a name or let WebObjects automatically assigns one at runtime.";
},{
name = "value";
description = "During page generation, value specifies the text that is displayed in the text field. During request handling, value contains the text as the user left it.";
});
type = "WO_Standard";
};
WOTextField = {
name = "WOTextField";
description = "A WOTextField represents itself as a text input field. It corresponds to the HTML element <INPUT TYPE=\"TEXT\"...";
attributes = ({
name = "disabled";
description = "If disabled evaluates to YES, the text area appears in the page but no input is allowed.";
default = "NO";
values = ("YES","NO");
},{
name = "dateformat";
description = "A format string that specifies how value should be formatted as a date. If a date format is used, value must be assigned an NSCalendarDate object. If value can't be interpreted according to the format you specify, value is set to nil. See the NSCalendarDate class specification for a description of the date format syntax.";
description = "Name that uniquely identifies this element within the form. You may specify a name or let WebObjects automatically assign one at runtime.";
},{
name = "numberformat";
description = "A format string that specifies how value should be formatted as a number. If a number format is used, value must be assigned an NSDecimalNumber object. If the element's value can't be interpreted according to the format you specify, value is set to nil. See the NSNumberFormatter class specification for a description of the number format syntax.";
description = "During page generation, value sets the default value of the text field. This value is not displayed to the user. During request handling, value holds the value the user entered into the field, or the default value if the user left the field untouched.";
});
type = "WO_Standard";
};
WOVBScript = {
name = "WOVBScript";
description = "WOVBScript lets you embed a script written in Visual Basic in a dynamically generated page. ";
attributes = ({
name = "hideInComment";
description = "If hideInComment evaluates to YES, the script will be enclosed in an HTML comment (<!-- script -->). Since scripts can generate errors in some older browsers that weren't designed to execute them, you may want to enclose your script in an HTML comment. Browsers designed to run these scripts will still be able to execute them despite the surrounding comment tags.";
default = "YES";
values = ("YES","NO");
},{
name = "scriptFile";
description = "Path to the file containing the script. The path can be statically specified in the declaration file or it can be an NSString, an object that responds to a description message by returning an NSString, or a method that returns an NSString.";
},{
name = "scriptSource";
description = "URL specifying the location of the script. ";
},{
name = "scriptString";
description = "String containing the script. Typically, scriptString is an NSString object, an object that responds to a description message by returning an NSString, or a method that returns an NSString.";
});
type = "WO_Standard";
};
"-0" = {
name = "Dynamic Elements (Extensions)";
attributes = ();
type = "Custom";
description = "Shared Components defined in the WOExtensions Framework";
};
WOCheckBoxList = {
name = "WOCheckBoxList";
description = "WOCheckBoxList displays a list of check boxes. The user may select several of the objects in the list, and this sublist is returned as selections.";
attributes = ({
name = "disabled";
description = "If disabled evaluates to YES, this element appears in the page but is not active.";
default = "YES";
values = ("YES","NO");
},{
name = "index";
description = "Index of the current iteration of the WOCheckBoxList.";
},{
name = "item";
description = "Current item in the list array. (This attribute's value is updated with each iteration.)";
},{
name = "list";
description = "Array of objects that the WOCheckBoxList will iterate through.";
},{
name = "name";
description = "Name that uniquely identifies this element within the form. You may specify a name or let WebObjects automatically assign one at runtime. ";
},{
name = "prefix";
description = "An arbitrary HTML string inserted before each value. ";
},{
name = "selections";
description = "An array of objects that the user chose from the list.";
},{
name = "suffix";
description = "An arbitrary HTML string inserted after each value.";
},{
name = "value";
description = "String to display beside the check box for the current item.";
});
type = "WO_Standard";
};
WONestedList = {
name = "WONestedList";
description = "WONestedList recursively displays a hierarchical, ordered (numbered) or unordered (bulleted) list of hyperlinks. This element is useful when you want to display hierarchical lists. When the user clicks one of the objects in the list, it is returned in selection and the action method is invoked. At any point during iteration of the list, the method specified by the sublist attribute returns the current list's sublist (if any), level specifies the current nesting level (where the topmost level is zero), index gives index of the current item within that nesting level (item returns the actual item), and isOrdered specifies whether the current sublist should be a numbered list or a bulleted list.";
attributes = ({
name = "action";
description = "Action method to invoke when the element is activated. This method must return a WOElement. ";
},{
name = "disabled";
description = "If disabled evaluates to YES, this element appears in the page but is not active.";
default = "YES";
values = ("YES","NO");
},{
name = "index";
description = "Index of the current iteration of the WONestedList. The index is unique to each level-that is, it starts at 0 for each sublist.";
},{
name = "item";
description = "Current item in the list array. (This attribute's value is updated with each iteration.)";
},{
name = "isOrdered";
description = "If isOrdered evaluates to YES, the current sublist is rendered as an ordered list. The default is to render as an unordered list.";
default = "YES";
values = ("YES","NO");
},{
name = "list";
description = "Hierarchical array of objects that the WONestedList will iterate through.";
},{
name = "level";
description = "Nesting level of the current iteration of the WONestedList. The topmost level is level 0.";
},{
name = "name";
description = "Name that uniquely identifies this element within the form. You may specify a name or let WebObjects automatically assign one at runtime. ";
},{
name = "prefix";
description = "An arbitrary HTML string inserted before each value.";
},{
name = "selection";
description = "When the page is submitted, selection contains the item that the user clicked.";
},{
name = "sublist";
description = "Method that returns the sublist of the current item or nil if the current item is a leaf.";
},{
name = "suffix";
description = "An arbitrary HTML string inserted after each value.";
},{
name = "value";
description = "String to display as a hyperlink for the current item.";
});
type = "WO_Standard";
};
WORadioButtonList = {
name = "WORadioButtonList";
description = "WORadioButtonList displays a list of radio buttons. The user may select one of the objects in the list, and this object is returned as selection.";
attributes = ({
name = "disabled";
description = "If disabled evaluates to YES, this element appears in the page but is not active.";
default = "YES";
values = ("YES","NO");
},{
name = "index";
description = "Index of the current iteration of the WORadioButtonList.";
},{
name = "item";
description = "Current item in the list array. (This attribute's value is updated with each iteration.)";
},{
name = "list";
description = "Array of objects that the WORadioButtonList will iterate through.";
},{
name = "name";
description = "Name that uniquely identifies this element within the form. You may specify a name or let WebObjects automatically assign one at runtime. ";
},{
name = "prefix";
description = "An arbitrary HTML string inserted before each value. ";
},{
name = "selection";
description = "An object that the user chose from the list.";
},{
name = "suffix";
description = "An arbitrary HTML string inserted after each value.";
},{
name = "value";
description = "String to display beside the check box for the current item.";
});
type = "WO_Standard";
};
WORedirect = {
name = "WORedirect";
description = "WORedirect is a component that may be returned to force the user's browser to redirect to another URL. You should only return this component as a response to an action method and never use it in an declarations file directly. This component can be useful, for example, if you have an image map with both static and dynamic actions.";
attributes = ({
name = "url";
description = "Redirect this URL";
});
type = "WO_Standard";
};
WOSimpleArrayDisplay = {
name = "WOSimpleArrayDisplay";
description = "The WOSimpleArrayDisplay component is intended to display a to-many relationship of an Enterprise Object. It could also be used to display an array of objects. The WOSimpleArrayDisplay is designed to only provide an idea of what is in the relationship (or list). It only displays the first n items in the list, where n is specified by the numberToDisplay attribute. (The default is 5.) If you want, you can have a hyperlink displayed at the bottom of the list by specifying the listAction and listString attributes. You could use this hyperlink to provide more information about the relationship or, for example, to list all of the elements in the relationship. If you use Direct to Web to create your application, you may have a page that uses WOSimpleArrayDisplay.";
attributes = ({
name = "itemDisplayKey";
description = "Key to the value that should be displayed for each item. For example, if you were displaying a movies entity object, you'd want to display the value of the movieName key. ";
},{
name = "list";
description = "Array of items to display.";
},{
name = "listAction";
description = "Method to perform when the hyperlink is clicked.";
},{
name = "listActionString";
description = "The string that should appear on the hyperlink. The default is \"Inspect.\"";
default = "\"Inspect.\"";
},{
name = "numberToDisplay";
description = "The number of items to display at one time. The default is 5 items.";
});
type = "WO_Standard";
};
WOSortOrder = {
name = "WOSortOrder";
description = "The WOSortOrder component displays an active image that shows the current sort ordering for a WODisplayGroup and allows the user to change it. A WODisplayGroup's sort ordering specifies the order in which items it displays should be displayed (ascending or descending).";
attributes = ({
name = "displayGroup";
description = "WODisplayGroup to be sorted.";
},{
name = "key";
description = "Key on which the WODisplayGroup should be sorted.";
});
type = "WO_Standard";
};
WOToManyRelationship = {
name = "WOToManyRelationship";
description = "The WOToManyRelationship component displays items from a to-many relationship in either a browser or a check-box list. Users can select one or more items from this list to learn more about those items. For example, suppose you have a database of Movies where each movie is a table (or entity). Each movie has one or more roles, which means that the Movies table would have a to-many relationship with the MovieRoles table. You could use this component on a page that displays information about a movie, using this component to display the roles associated with this movie. This component is used only in applications that access a database using the Enterprise Objects Framework. In particular, it is used if you use Direct to Web to create your application. Because WOToManyRelationship returns a form element, it must be used within an HTML form.";
attributes = ({
name = "dataSource";
description = "EODatabaseDatasource containing the items in the to-many relationship.";
},{
name = "destinationDisplayKey";
description = "Property to display in the list. For example, with the MovieRoles entity, you would want to display the roleName property.";
},{
name = "isMandatory";
description = "If YES, the relationship must exist. If the relationship must exist, the element must have at least one item selected when the form is submitted, so the WOToManyRelationship selects the first item if the list if the user has not selected any. If NO, the relationship is optional.";
},{
name = "relationshipKey";
description = "The key for the relationship that you want to display. In the Movies example, you'd want to displa the roles key. ";
},{
name = "sourceEntityName";
description = "The name of the entity that contains the relationship. In the Movies example, this would be \"Movies.\"";
},{
name = "sourceObject";
description = "An object that contains the actual relationship value. This object can be an enterprise object, a mutable dictionary, or anything else that can contain the relationship. Upon return, this object contains the user's selection.";
},{
name = "uiStyle";
description = "If \"browser\", displays as a browser. If \"checkbox\", displays as a list of check boxes. The default depends on the number of items in the list. If there are less than 5 items, the default is a check-box list. If there are 5 items or more, the default is a browser.";
});
type = "WO_Standard";
};
WOToOneRelationship = {
name = "WOToOneRelationship";
description = "The WOToOneRelationship component displays items from a to-one relationship in a pop-up list, a radio button list, or a browser. Users can select an item from this list to learn more about that item. For example, suppose you have a database of Movies where each movie is a table (or entity). Each movie has only one studio, which means that the Movies table would have a to-one relationship with the Studios table. You could use this component on a page that displays information about a movie, using this component to display the studio associated with the movie. This component is used only in applications that access a database using the Enterprise Objects Framework. In particular, it is used if you use Direct to Web to create your application. Because WOToOneRelationship returns a form element, it must be used within an HTML form.";
attributes = ({
name = "dataSource";
description = "EODatabaseDataSource containing the items in the to-one relationship.";
},{
name = "destinationDisplayKey";
description = "Property to display in the list. For example, with the Studio entity, you would want to display the name property.";
},{
name = "isMandatory";
description = "If YES, the relationship must exist. If NO, the relationship is optional.";
},{
name = "relationshipKey";
description = "The key for the relationship that you want to display. In the Movies example, you'd want to display the studios key.";
},{
name = "sourceEntityName";
description = "The name of the entity that contains the relationship. In the Movies example, this would be \"Movies.\"";
},{
name = "sourceObject";
description = "An object that contains the actual relationship value. This object can be an enterprise object, a mutable dictionary, or anything else that can contain the relationship. Upon return, this object contains the user's selection.";
},{
name = "uiStyle";
description = "Specifies how to display the list: as a browser, a radio button list, or a pop-up list. The default depends on the number of items in the list. If there are less than 5 items, the default is a radio button list. If between 5 and 20 items, the default is a pop-up list. If there are more than 20 items, a browser is used.";
});
type = "WO_Standard";
};
"-" = {
attributes = ();
name = "Reusable Components";
type = "Custom";
description = "Reusable Components defined in the ReusableComponents Framework";
};
AlertPanel = {
attributes = ({
default = "";
description = "The string that's displayed at the top of the panel. Default is \"Alert!\"";
name = "alertString";
values = ();
},{
default = "";
description = "The color of the alertString. Default is #ff0000.";
name = "alertFontColor";
values = ();
},{
default = "";
description = "The size of the alertString. Default is 6.";
name = "alertFontSize";
values = ();
},{
default = "";
description = "The user's error message. Default is \"User should provide an infoString\".";
name = "infoString";
values = ();
},{
default = "";
description = "The color of infoString. Default is #ff0000.";
name = "infoFontColor";
values = ();
},{
default = "";
description = "The size of infoString. Default is 4.";
name = "infoFontSize";
values = ();
},{
default = "";
description = "The table's boder size. Default is 2.";
name = "borderSize";
values = ();
},{
default = "";
description = "The table's width. Default is 33%. May either be in percent or in pixels.";
name = "tableWidth";
values = ();
});
description = "The AlertPanel provides a standardized way to present error messages to the user.";
name = "AlertPanel";
type = "Custom";
};
ArrayEditor = {
attributes = ({
default = "";
description = "The array whose content strings will be displayed in the ArrayEditor. On input, this array is updated with any changes that the user made to the displayed strings.";
name = "array";
values = ();
},{
default = "";
description = "The size of the text fields that display the strings of the array. All text fields have the same size, as set by this parameter. The default is 20 characters.";
name = "fieldSize";
values = ();
},{
default = "";
description = "The width of the table border. Default is 1.";
name = "borderSize";
values = ();
},{
default = "";
description = "The margin around of each cell in the table. Default is 2.";
name = "cellPadding";
values = ();
},{
default = "";
description = "The space between the cells in the table. Default is 0.";
name = "cellSpacing";
values = ();
});
description = "The ArrayEditor component lets the user edit an NSMutableArray of NSStrings. ArrayEditor displays the strings in text fields within a table. The ArrayEditor's text fields are provided by the ReadWriteString reusable component, which allows the user to edit the strings.";
name = "ArrayEditor";
type = "Custom";
};
AttributeEditor = {
attributes = ({
default = "";
description = "An array of strings that are the keys for the associated valueArray. These strings can be immutable (NSStrings).";
name = "keyArray";
values = ();
},{
default = "";
description = "An array of strings that are the values for the associated keyArray. These strings must be mutable (NSMutableStrings). Upon return, this array is updated with any changes that the user made to the displayed values.";
name = "valueArray";
values = ();
},{
default = "";
description = "Sets whether the attribute values can be edited. The default is NO.";
name = "isEditable";
values = ();
},{
default = "";
description = "Sets the size of the text fields that display the strings. The default is 15 characters.";
name = "fieldSize";
values = ();
},{
default = "";
description = "Sets the width of the table border. Default is 1.";
name = "borderSize";
values = ();
},{
default = "";
description = "Sets the margin around of each cell in the table. Default is 2.";
name = "cellPadding";
values = ();
},{
default = "";
description = "Sets the spacing between the cells in the table. Default is 0.";
name = "cellSpacing";
values = ();
});
description = "The AttributeEditor component lets the user edit the values associated with a set of keys. To use this component, simply pass a pair of arrays, one containing the keys (keyArray) and the other containing the values (valueArray) associated with these keys. Changes made to the value strings will be reflected in the returned array of values. The array of keys will never change, so it can be immutable.";
name = "AttributeEditor";
type = "Custom";
};
CalendarRadio = {
attributes = ({
default = "";
description = "On output, sets the selected radio button for the given day. On input, indicates the user's choice of day. The default is the current day, as determined by the system clock.";
name = "dayChoice";
values = ();
},{
default = "";
description = "On output, sets the month displayed. On input, indicates the user's choice of month. The default is the current month, as determined by the system clock.";
name = "currentMonth";
values = ();
},{
default = "";
description = "On output, sets the year displayed. On input, indicates the user's choice of year. The default is the current year, as determined by the system clock.";
name = "currentYear";
values = ();
},{
default = "";
description = "The size of the font used to display the numbers for each day. Default is 3.";
name = "dayFontSize";
values = ();
},{
default = "";
description = "The size of the font used to display the month's name (at the top). Default is 5.";
name = "monthFontSize";
values = ();
},{
default = "";
description = "The size of the font used to display the year's name (at the top). Default is 4.";
name = "yearFontSize";
values = ();
},{
default = "";
description = "A boolean (YES|NO) which turns on/off the display of the radio buttons.";
name = "showButtons";
values = ();
},{
default = "";
description = "Determines the alignment of the text and radio button in the cells of the calendar. Possible values are \"left\", \"center\", \"right\".";
name = "cellAlignment";
values = ();
},{
default = "";
description = "The width of the border of the matrix. Default is 1.";
name = "borderSize";
values = ();
},{
default = "";
description = "The margin around each cell in the matrix. Default is 0.";
name = "cellPadding";
values = ();
},{
default = "";
description = "The space between the cells in the matrix. Default is 0.";
name = "cellSpacing";
values = ();
});
description = "The CalendarRadio component provides an off-the-shelf calendar you can drop into your applications. This calendar is implemented as a matrix of radio buttons so that the user can choose only a single day of the month.\r\n\r\nThis calendar is highly configurable in terms of its display options. You can even turn off the radio buttons if you decide you want a display-only calendar.";
name = "CalendarRadio";
type = "Custom";
};
CheckBoxMatrix = {
attributes = ({
default = "";
description = "An array of strings that will become the labels as well as the return value.";
name = "list";
values = ();
},{
default = "";
description = "Indicates which buttons are initially selected. Upon return, indicates the user's choice (or nil if nothing is chosen).";
name = "selections";
values = ();
},{
default = "";
description = "Used to distinguish the WOCheckBoxes used in this CheckBoxMatrix from those in any other CheckBoxMatrix.";
name = "matrixName";
values = ();
},{
default = "";
description = "The orientation of the matrix. Default is YES.";
name = "isVertical";
values = ();
},{
default = "";
description = "The width of the border of the matrix. Default is 1.";
name = "borderSize";
values = ();
},{
default = "";
description = "The margin around each cell in the matrix. Default is 2.";
name = "cellPadding";
values = ();
},{
default = "";
description = "The space between the cells in the matrix. Default is 0.";
name = "cellSpacing";
values = ();
});
description = "The CheckBoxMatrix provides a simplified interface to the WOCheckBox dynamic element. In order to distinguish the WOCheckBoxes used in this component from those in any other component, you must pass a name (matrixName). In addition, you must pass an array of strings (list) that will serve as the labels of the check boxes. Finally, you must indicate which items (selections) are selected.";
name = "CheckBoxMatrix";
type = "Custom";
};
DictionaryTable = {
attributes = ({
default = "";
description = "The dictionary whose contents will be displayed in the DictionaryTable.";
name = "dictionary";
values = ();
},{
default = "";
description = "The width of the table border. Default is 1.";
name = "borderSize";
values = ();
},{
default = "";
description = "The margin around of each cell in the table. Default is 2.";
name = "cellPadding";
values = ();
},{
default = "";
description = "The space between the cells in the table. Default is 0.";
name = "cellSpacing";
values = ();
});
description = "The DictionaryTable displays the contents of an NSDictionary. Note that the order of the elements in the dictionary is random (as that is the nature of NSDictionarys).";
name = "DictionaryTable";
type = "Custom";
};
FileEditor = {
attributes = ({
default = "";
description = "The path to the file (on the server) that you want to allow the user to edit.";
name = "pathName";
values = ();
},{
default = "";
description = "The number of rows to display in the text area. Default is 15.";
name = "rows";
values = ();
},{
default = "";
description = "The number of columns to display in the text area. Default is 65.";
name = "cols";
values = ();
});
description = "The FileEditor component allows for the editing of a file. The file should be owned by nobody (or whomever starts the WebObjects application), or it should be writable by everyone. Also, since the file is written \"atomically\", the directory in which the file resides must be owned by nobody, or be writable by everyone. To use FileEditor, you pass the pathName of the file you want to display or edit; FileEditor takes care of the rest. You must wrap the FileEditor in <form> tags in order for it to work properly.\r\n\r\nFileEditor provides Save and Revert buttons. If the save process fails an error message is displayed, but the user's work is not lost. If the user clicks the Revert button, the text area is restored from the file as it was last saved.\r\n\r\nIf this proves to be a useful component, it may make sense to create some sort of locking mechanism to prevent multiple users from editing the same file and overwriting each other.";
name = "FileEditor";
type = "Custom";
};
FileString = {
attributes = ({
default = "";
description = "The path to the file you want to display.";
name = "pathName";
values = ();
},{
default = "";
description = "A boolean (YES|NO) indicating whether or not to escape any HTML tags which may be embedded in your file. The default is YES.";
name = "escapeHTML";
values = ();
});
description = "The FileString component makes it easy to display the contents of a file in your WOF application. FileString functions like HTMLString except that, rather than passing a string, you pass the path name of the file you want to display. FileString is based on HTMLString so is capable of inserting HTML tags directly into the outgoing page. However, the default is to have escapeHTML turned on, so you must explicitly set escapeHTML to NO to override the default.\r\n\r\n\r\nFor the pathName argument, you must provide a complete path to the file. See \"-pathForResource:\" in the WOApplication class.";
name = "FileString";
type = "Custom";
};
FontChoice = {
attributes = ({
default = "";
description = "Used to distinguish the WORadioButtons used in this RadioMatrix from those in any other RadioMatrix.";
name = "matrixName";
values = ();
},{
default = "";
description = "If initialized, indicates which button is initially selected. Upon return, indicates the user's choice (or nil if nothing is chosen). Default is item 3.";
name = "selectedItem";
values = ();
},{
default = "";
description = "The width of the border of the matrix. Default is 1.";
name = "borderSize";
values = ();
},{
default = "";
description = "The orientation of the matrix. Default is NO.";
name = "isVertical";
values = ();
});
description = "The FontChoice component is a ready-made RadioMatrix that is intended to allow the user to choose one of the 7 HTML font sizes. As it is merely a RadioMatrix initialized with 7 radio buttons, most of the usual RadioMatrix options are available.";
name = "FontChoice";
type = "Custom";
};
FontString = {
attributes = ({
default = "";
description = "The text that the string displays in the HTML page. The default is \"Uninitialized FontString\".";
name = "value";
values = ();
},{
default = "";
description = "The string's font size. The default is 5.";
name = "fontSize";
values = ();
},{
default = "";
description = "The string's text color. The default is black.";
name = "fontColor";
values = ();
},{
default = "";
description = "A Boolean (YES|NO) indicating how to deal with HTML tags in the string. The default is YES.";
name = "escapeHTML";
values = ();
});
description = "The FontString component bundles the text, font size, and color attributes of a string into a single package. FontString is based on WOString so is capable of passing raw HTML tags into the outgoing page (the default is to escape the tags).";
name = "FontString";
type = "Custom";
};
MonthChoice = {
attributes = ({
default = "";
description = "Takes an NSString argument and sets the month that's initially selected in the MonthChoice component. Upon return, contains the user's choice (or nil if nothing is chosen). The default is the current month, as determined by the system clock.";
name = "selectedMonth";
values = ();
},{
default = "";
description = "Takes an integer argument and sets the month that's initially selected in the MonthChoice component. Upon return, contains the user's choice (or nil if nothing is chosen). The default is the current month, as determined by the system clock.";
name = "selectedMonthInt";
values = ();
},{
default = "";
description = "The width of the table border. Default is 1.";
name = "borderSize";
values = ();
},{
default = "";
description = "The margin around of each cell in the table. Default is 2.";
name = "cellPadding";
values = ();
},{
default = "";
description = "The space between the cells in the table. Default is 0.";
name = "cellSpacing";
values = ();
});
description = "The MonthChoice component is a ready-made RadioMatrix that lets you get a month selection from the user. To use, set a matrixName to distinguish it from other matrices that might be in your form. Also, set the table's borderSize to any integer value (0 turns off the border completely), and set the cellPadding and cellSpacing variables to alter the spacing of the table.\r\n\r\nYou can also initialize the selected month by either setting the selectedMonth or selectedMonthInt variables (setting one will automatically set the other). Valid options for selectedMonth are: \"Jan\", \"Feb\", \"Mar\", \"Apr\", \"May\", \"Jun\", \"Jul\", \"Aug\", \"Sep\", \"Oct\", \"Nov\", \"Dec\". Valid options for selectedMonthInt are integers from 1 to 12. When the form is submitted, both the string and the integer variables will be set to whatever the user chose.";
name = "MonthChoice";
type = "Custom";
};
MultipleSubmitButton = {
attributes = ({
default = "";
description = "The action that's invoked when the button is clicked. The action method must be implemented in the parent component (the one employing the MultipleSubmitButton component).";
name = "parentAction";
values = ();
},{
default = "";
description = "The image you want to use for the button. A default image is provided.";
name = "buttonImage";
values = ();
});
description = "In general, you can't have multiple submit buttons within a single form. With MultipleSubmitButton, you can. The MultipleSubmitButton component behaves like a WOSubmitButton except that it uses a \"gif\" image for the button itself. Since the button's image comes from a file, you can't set it's title programmatically. However, you can provide your own image for the button using the buttonImage variable, so in a sense, MultipleSubmitButton is more flexible than a standard submit button. \r\n\r\nYou must pass the parentAction argument so the button can know what action to invoke. You define parentAction in the component that's using the MultipleSubmitButton.";
name = "MultipleSubmitButton";
type = "Custom";
};
NoContent = {
attributes = ({
default = "";
description = "";
name = "No parameters";
values = ();
});
description = "The NoContent component allows for data submission from a form without unnecessary refresh of the user's browser page. You treat this component like a page. To use, simply do the following wherever you would otherwise return a page:\r\n\r\n\r\n\r\nreturn [WOApp pageWithName:@\"NoContent\"];\r\n\r\n\r\n";
name = "NoContent";
type = "Custom";
};
ObjectArrayEditor = {
attributes = ({
default = "";
description = "The array of objects to be edited/displayed. All objects must conform to WOKeyValueCoding.";
name = "objectArray";
values = ();
},{
default = "";
description = "An NSArray holding the labels displayed on the top of the ObjectArrayEditor table.";
name = "labelArray";
values = ();
},{
default = "";
description = "An NSArray holding the names of the ivars to be edited/displayed.";
name = "keyArray";
values = ();
},{
default = "";
description = "An optional array of column widths. Default column width is 12.";
name = "columnWidthArray";
values = ();
},{
default = "";
description = "The column width to use if columnWidthArray is not specified. Default is 12.";
name = "fieldSize";
values = ();
},{
default = "";
description = "A boolean (YES|NO) to determine if the table is editable or for display purposes only. Default is NO.";
name = "isEditable";
values = ();
},{
default = "";
description = "The width of the table border. Default is 1.";
name = "borderSize";
values = ();
},{
default = "";
description = "The margin around of each cell in the table. Default is 2.";
name = "cellPadding";
values = ();
},{
default = "";
description = "The space between the cells in the table. Default is 0.";
name = "cellSpacing";
values = ();
});
description = "The ObjectArrayEditor supports the editing of an array of Enterprise Objects. To use, simply pass objectArray (an array objects that conform to WOKeyValueCoding) along with keyArray (an array of keys which indicate the attributes to display) and labelArray (an array of labels which are used in the heading). Also, you may pass columnWidthArray, an optional array of column widths.\r\n\r\nThe ObjectArrayEditor uses the ReadWriteString component to display its values. You can either display values as editable WOTextFields or as read-only WOStrings. Simply pass the isEditable value as either \"YES\" or \"NO\".\r\n\r\nYou can also set the usual optional parameters such as borderSize, cellPadding, and cellSpacing.";
name = "ObjectArrayEditor";
type = "Custom";
};
ObjectEditor = {
attributes = ({
default = "";
description = "The object to be edited. Must conform to WOKeyValueCoding.";
name = "targetObject";
values = ();
},{
default = "";
description = "An NSArray holding the labels displayed on the left of the ObjectEditor table";
name = "labelArray";
values = ();
},{
default = "";
description = "An NSArray holding the names of the instance variables to be edited/displayed.";
name = "keyArray";
values = ();
},{
default = "";
description = "The length of the TextField cells on the right side of the table. Default is 15.";
name = "fieldSize";
values = ();
},{
default = "";
description = "A boolean (YES|NO) to determine if the table is editable or for display purposes only. Default is NO.";
name = "isEditable";
values = ();
},{
default = "";
description = "The width of the table border. Default is 1.";
name = "borderSize";
values = ();
},{
default = "";
description = "The margin around of each cell in the table. Default is 0.";
name = "cellPadding";
values = ();
},{
default = "";
description = "The space between the cells in the table. Default is 0.";
name = "cellSpacing";
values = ();
});
description = "The ObjectEditor supports the editing of an Enterprise Object. To use, simply pass targetObject (any object that conforms to WOKeyValueCoding protocol) along with keyArray (an array of keys that indicate the attributes to display) and labelArray (an array of labels which are used in the headings). Also, you may pass fieldWidth, an optional field width.\r\n\r\nThe ObjectEditor uses the ReadWriteString component to display the values. You can either display values as editable WOTextFields or as read-only WOStrings. Simply set the isEditable value as either \"YES\" or \"NO\".\r\n\r\nYou can also set the usual optional parameters such as borderSize, cellPadding, and cellSpacing.";
name = "ObjectEditor";
type = "Custom";
};
PoweredByWebObjects = {
attributes = ({
default = "";
description = "";
name = "No parameters for this component";
values = ();
});
description = "The PoweredByWebObjects component provides a standard component for the \"Powered by WebObjects\" logo. In addition to encapsulating the image, this component also takes care of specifying the proper link to www.next.com.\r\n\r\nThis component makes it easy to maintain the WebObjects logo. If either the graphics or the link should need to be changed in the future, you simply change it in this one place and it'll be fixed in all places.";
name = "PoweredByWebObjects";
type = "Custom";
};
RadioMatrix = {
attributes = ({
default = "";
description = "An array of strings that will become the labels as well as the return value.";
name = "list";
values = ();
},{
default = "";
description = "If initialized, indicates which button is initially selected. Upon return, indicates the user's choice (or nil if nothing is chosen).";
name = "selection";
values = ();
},{
default = "";
description = "Used to distinguish the WORadioButtons used in this RadioMatrix from those in any other component on the same page.";
name = "matrixName";
values = ();
},{
default = "";
description = "The orientation of the matrix. Default is YES.";
name = "isVertical";
values = ();
},{
default = "";
description = "The width of the border of the matrix. Default is 1.";
name = "borderSize";
values = ();
},{
default = "";
description = "The margin around each cell in the matrix. Default is 2.";
name = "cellPadding";
values = ();
},{
default = "";
description = "The space between the cells in the matrix. Default is 0.";
name = "cellSpacing";
values = ();
});
description = "The RadioMatrix provides a simplified interface to the WORadioButton dynamic element. In order to distinguish the set of WORadioButtons used in this component from those in any other component, you must provide a name for the matrix (matrixName). In addition, you must pass an array of strings (list) that will serve as the labels of the radio buttons. Finally, you must indicate which item (selection) is selected.";
name = "RadioMatrix";
type = "Custom";
};
ReadWriteString = {
attributes = ({
default = "";
description = "The text that the string displays in the HTML page.";
name = "value";
values = ();
},{
default = "";
description = "Controls the editability of the string (YES|NO). If YES, the string will be editable.";
name = "isEditable";
values = ();
});
description = "The ReadWriteString component lets you set whether a displayed string is editable. Note: The string must be inside a form for it to be editable.";
name = "ReadWriteString";
type = "Custom";
};
Redirect = {
attributes = ({
default = "";
description = "The page which the client will ultimately see.";
name = "urlString";
values = ();
},{
default = "";
description = "A boolean (YES|NO) indcating if the document has moved permanently, or just temporarily.";
name = "permanent";
values = ();
});
description = "The Redirect component lets you return a page other than the one which was requested. Simply place a Redirect component anywhere within your existing HTML file, add the appropriate declaration into the .wod file (pass it an urlString), and the client browser will no longer see your page, but will see the page at urlString.";
name = "Redirect";
type = "Custom";
};
TitleBox = {
name = "TitleBox";
description = "A TitleBox provides a convenient and consistent way to display a title across a page. You may choose the font size and color for the text that displays in the box. The width of the box is always the width of the page.";
attributes = ({
name = "value";
values = ();
default = "";
description = "The string that will be displayed. No default vlaue is provided. TitleBox is based on FontString which is based on HTMLString, therefore you can control whether or not raw HTML tags are escaped.";
},{
name = "fontColor";
values = ();
default = "";
description = "A string representing a color value in standard HTML format (#rrggbb, where \"rr\", \"gg\", and \"bb\" are two-digit hex values). The default fontColor is as per FontString.";
},{
name = "fontSize";
values = ();
default = "";
description = "A value from 1 to 7 which cooses on the the seven HTML font sizes. The default fontSize is as per FontString.";
},{
name = "escapeHTML";
values = ("YES","NO");
default = "";
description = "A Boolean (YES|NO) indicating how to deal with HTML tags in the string. The default is YES. See HTMLString for details.";
